
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>Table of Featurizers &#8212; matminer 0.5.4 documentation</title>
    <link rel="stylesheet" href="_static/nature.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
 
<link href='https://fonts.googleapis.com/css?family=Lato:400,700' rel='stylesheet' type='text/css'>

  </head><body>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">matminer 0.5.4 documentation</a> &#187;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="table-of-featurizers">
<h1>Table of Featurizers<a class="headerlink" href="#table-of-featurizers" title="Permalink to this headline">¶</a></h1>
<p>Below, you will find a description of each featurizer, listed in tables grouped by module.</p>
<div class="section" id="bandstructure">
<h2>bandstructure<a class="headerlink" href="#bandstructure" title="Permalink to this headline">¶</a></h2>
<div class="section" id="features-derived-from-a-material-s-electronic-bandstructure">
<h3>Features derived from a material’s electronic bandstructure.<a class="headerlink" href="#features-derived-from-a-material-s-electronic-bandstructure" title="Permalink to this headline">¶</a></h3>
<p>(matminer.featurizers.bandstructure)</p>
<table border="1" class="docutils">
<colgroup>
<col width="6%" />
<col width="94%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">BranchPointEnergy</span></code></td>
<td>Branch point energy and absolute band edge position. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.bandstructure.BranchPointEnergy">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">BandFeaturizer</span></code></td>
<td>Featurizes a pymatgen band structure object. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.bandstructure.BandFeaturizer">[more]</a></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="base">
<h2>base<a class="headerlink" href="#base" title="Permalink to this headline">¶</a></h2>
<div class="section" id="parent-classes-and-meta-featurizers">
<h3>Parent classes and meta-featurizers.<a class="headerlink" href="#parent-classes-and-meta-featurizers" title="Permalink to this headline">¶</a></h3>
<p>(matminer.featurizers.base)</p>
<table border="1" class="docutils">
<colgroup>
<col width="6%" />
<col width="94%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">MultipleFeaturizer</span></code></td>
<td>Class to run multiple featurizers on the same input data. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.base.MultipleFeaturizer">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">StackedFeaturizer</span></code></td>
<td>Use the output of a machine learning model as features <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.base.StackedFeaturizer">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">BaseFeaturizer</span></code></td>
<td>Abstract class to calculate features from raw materials input data <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.base.BaseFeaturizer">[more]</a></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="composition">
<h2>composition<a class="headerlink" href="#composition" title="Permalink to this headline">¶</a></h2>
<div class="section" id="features-based-on-a-material-s-composition">
<h3>Features based on a material’s composition.<a class="headerlink" href="#features-based-on-a-material-s-composition" title="Permalink to this headline">¶</a></h3>
<p>(matminer.featurizers.composition)</p>
<table border="1" class="docutils">
<colgroup>
<col width="7%" />
<col width="93%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">ElementProperty</span></code></td>
<td>Class to calculate elemental property attributes. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.composition.ElementProperty">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">OxidationStates</span></code></td>
<td>Statistics about the oxidation states for each specie. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.composition.OxidationStates">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">AtomicOrbitals</span></code></td>
<td>Determine HOMO/LUMO features based on a composition. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.composition.AtomicOrbitals">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">BandCenter</span></code></td>
<td>Estimation of absolute position of band center using electronegativity. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.composition.BandCenter">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">ElectronegativityDiff</span></code></td>
<td>Features from electronegativity differences between anions and cations. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.composition.ElectronegativityDiff">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">ElectronAffinity</span></code></td>
<td>Calculate average electron affinity times formal charge of anion elements. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.composition.ElectronAffinity">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">Stoichiometry</span></code></td>
<td>Calculate norms of stoichiometric attributes. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.composition.Stoichiometry">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">ValenceOrbital</span></code></td>
<td>Attributes of valence orbital shells <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.composition.ValenceOrbital">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">IonProperty</span></code></td>
<td>Ionic property attributes. Similar to ElementProperty. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.composition.IonProperty">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">ElementFraction</span></code></td>
<td>Class to calculate the atomic fraction of each element in a composition. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.composition.ElementFraction">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">TMetalFraction</span></code></td>
<td>Class to calculate fraction of magnetic transition metals in a composition. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.composition.TMetalFraction">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">CohesiveEnergy</span></code></td>
<td>Cohesive energy per atom using elemental cohesive energies and <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.composition.CohesiveEnergy">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">Miedema</span></code></td>
<td>Formation enthalpies of intermetallic compounds, from Miedema et al. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.composition.Miedema">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">YangSolidSolution</span></code></td>
<td>Mixing thermochemistry and size mismatch terms of Yang and Zhang (2012) <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.composition.YangSolidSolution">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">AtomicPackingEfficiency</span></code></td>
<td>Packing efficiency based on a geometric theory of the amorphous packing <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.composition.AtomicPackingEfficiency">[more]</a></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="conversions">
<h2>conversions<a class="headerlink" href="#conversions" title="Permalink to this headline">¶</a></h2>
<div class="section" id="conversion-utilities">
<h3>Conversion utilities.<a class="headerlink" href="#conversion-utilities" title="Permalink to this headline">¶</a></h3>
<p>(matminer.featurizers.conversions)</p>
<table border="1" class="docutils">
<colgroup>
<col width="8%" />
<col width="92%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">ConversionFeaturizer</span></code></td>
<td>Abstract class to perform data conversions. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.conversions.ConversionFeaturizer">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">StrToComposition</span></code></td>
<td>Utility featurizer to convert a string to a Composition <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.conversions.StrToComposition">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">StructureToComposition</span></code></td>
<td>Utility featurizer to convert a Structure to a Composition. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.conversions.StructureToComposition">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">StructureToIStructure</span></code></td>
<td>Utility featurizer to convert a Structure to an immutable IStructure. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.conversions.StructureToIStructure">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">DictToObject</span></code></td>
<td>Utility featurizer to decode a dict to Python object via MSON. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.conversions.DictToObject">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">JsonToObject</span></code></td>
<td>Utility featurizer to decode json data to a Python object via MSON. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.conversions.JsonToObject">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">StructureToOxidStructure</span></code></td>
<td>Utility featurizer to add oxidation states to a pymatgen Structure. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.conversions.StructureToOxidStructure">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">CompositionToOxidComposition</span></code></td>
<td>Utility featurizer to add oxidation states to a pymatgen Composition. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.conversions.CompositionToOxidComposition">[more]</a></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dos">
<h2>dos<a class="headerlink" href="#dos" title="Permalink to this headline">¶</a></h2>
<div class="section" id="features-based-on-a-material-s-electronic-density-of-states">
<h3>Features based on a material’s electronic density of states.<a class="headerlink" href="#features-based-on-a-material-s-electronic-density-of-states" title="Permalink to this headline">¶</a></h3>
<p>(matminer.featurizers.dos)</p>
<table border="1" class="docutils">
<colgroup>
<col width="5%" />
<col width="95%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">SiteDOS</span></code></td>
<td>report the fractional s/p/d/f dos for a particular site. a CompleteDos <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.dos.SiteDOS">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">DOSFeaturizer</span></code></td>
<td>Significant character and contribution of the density of state from a <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.dos.DOSFeaturizer">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">DopingFermi</span></code></td>
<td>The fermi level (w.r.t. selected reference energy) associated with a <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.dos.DopingFermi">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">Hybridization</span></code></td>
<td>quantify s/p/d/f orbital character and their hybridizations at band edges <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.dos.Hybridization">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">DosAsymmetry</span></code></td>
<td>Quantifies the asymmetry of the DOS near the Fermi level. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.dos.DosAsymmetry">[more]</a></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="function">
<h2>function<a class="headerlink" href="#function" title="Permalink to this headline">¶</a></h2>
<div class="section" id="classes-for-expanding-sets-of-features-calculated-with-other-featurizers">
<h3>Classes for expanding sets of features calculated with other featurizers.<a class="headerlink" href="#classes-for-expanding-sets-of-features-calculated-with-other-featurizers" title="Permalink to this headline">¶</a></h3>
<p>(matminer.featurizers.function)</p>
<table border="1" class="docutils">
<colgroup>
<col width="6%" />
<col width="94%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">FunctionFeaturizer</span></code></td>
<td>Features from functions applied to existing features, e.g. “1/x” <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.function.FunctionFeaturizer">[more]</a></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="site">
<h2>site<a class="headerlink" href="#site" title="Permalink to this headline">¶</a></h2>
<div class="section" id="features-from-individual-sites-in-a-material-s-crystal-structure">
<h3>Features from individual sites in a material’s crystal structure.<a class="headerlink" href="#features-from-individual-sites-in-a-material-s-crystal-structure" title="Permalink to this headline">¶</a></h3>
<p>(matminer.featurizers.site)</p>
<table border="1" class="docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">AGNIFingerprints</span></code></td>
<td>Product integral of RDF and Gaussian window function, from Botu et al. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.site.AGNIFingerprints">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">OPSiteFingerprint</span></code></td>
<td>Local structure order parameters computed from a site’s neighbor env. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.site.OPSiteFingerprint">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">CrystalNNFingerprint</span></code></td>
<td>A local order parameter fingerprint for periodic crystals. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.site.CrystalNNFingerprint">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">VoronoiFingerprint</span></code></td>
<td>Voronoi tessellation-based features around target site. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.site.VoronoiFingerprint">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">ChemicalSRO</span></code></td>
<td>Chemical short range ordering, deviation of local site and nominal structure compositions <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.site.ChemicalSRO">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">GaussianSymmFunc</span></code></td>
<td>Gaussian symmetry function features suggested by Behler et al. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.site.GaussianSymmFunc">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">EwaldSiteEnergy</span></code></td>
<td>Compute site energy from Coulombic interactions <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.site.EwaldSiteEnergy">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">ChemEnvSiteFingerprint</span></code></td>
<td>Resemblance of given sites to ideal environments <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.site.ChemEnvSiteFingerprint">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">CoordinationNumber</span></code></td>
<td>Number of first nearest neighbors of a site. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.site.CoordinationNumber">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">GeneralizedRadialDistributionFunction</span></code></td>
<td>Compute the general radial distribution function (GRDF) for a site. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.site.GeneralizedRadialDistributionFunction">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">AngularFourierSeries</span></code></td>
<td>Compute the angular Fourier series (AFS), including both angular and radial info <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.site.AngularFourierSeries">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">LocalPropertyDifference</span></code></td>
<td>Differences in elemental properties between site and its neighboring sites. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.site.LocalPropertyDifference">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">BondOrientationalParameter</span></code></td>
<td>Averages of spherical harmonics of local neighbors <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.site.BondOrientationalParameter">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">SiteElementalProperty</span></code></td>
<td>Elemental properties of atom on a certain site <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.site.SiteElementalProperty">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">AverageBondLength</span></code></td>
<td>Determines the average bond length between one specific site <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.site.AverageBondLength">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">AverageBondAngle</span></code></td>
<td>Determines the average bond angles of a specific site with <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.site.AverageBondAngle">[more]</a></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="structure">
<h2>structure<a class="headerlink" href="#structure" title="Permalink to this headline">¶</a></h2>
<div class="section" id="generating-features-based-on-a-material-s-crystal-structure">
<h3>Generating features based on a material’s crystal structure.<a class="headerlink" href="#generating-features-based-on-a-material-s-crystal-structure" title="Permalink to this headline">¶</a></h3>
<p>(matminer.featurizers.structure)</p>
<table border="1" class="docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">DensityFeatures</span></code></td>
<td>Calculates density and density-like features <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.structure.DensityFeatures">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">GlobalSymmetryFeatures</span></code></td>
<td>Determines symmetry features, e.g. spacegroup number and  crystal system <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.structure.GlobalSymmetryFeatures">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">Dimensionality</span></code></td>
<td>Returns dimensionality of structure: 1 means linear chains of atoms OR <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.structure.Dimensionality">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">RadialDistributionFunction</span></code></td>
<td>Calculate the radial distribution function (RDF) of a crystal structure. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.structure.RadialDistributionFunction">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">PartialRadialDistributionFunction</span></code></td>
<td>Compute the partial radial distribution function (PRDF) of an xtal structure <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.structure.PartialRadialDistributionFunction">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">ElectronicRadialDistributionFunction</span></code></td>
<td>Calculate the inherent electronic radial distribution function (ReDF) <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.structure.ElectronicRadialDistributionFunction">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">CoulombMatrix</span></code></td>
<td>The Coulomb matrix, a representation of nuclear coulombic interaction. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.structure.CoulombMatrix">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">SineCoulombMatrix</span></code></td>
<td>A variant of the Coulomb matrix developed for periodic crystals. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.structure.SineCoulombMatrix">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">OrbitalFieldMatrix</span></code></td>
<td>Representation based on the valence shell electrons of neighboring atoms. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.structure.OrbitalFieldMatrix">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">MinimumRelativeDistances</span></code></td>
<td>Determines the relative distance of each site to its closest neighbor. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.structure.MinimumRelativeDistances">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">SiteStatsFingerprint</span></code></td>
<td>Computes statistics of properties across all sites in a structure. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.structure.SiteStatsFingerprint">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">EwaldEnergy</span></code></td>
<td>Compute the energy from Coulombic interactions. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.structure.EwaldEnergy">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">BondFractions</span></code></td>
<td>Compute the fraction of each bond in a structure, based on NearestNeighbors. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.structure.BondFractions">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">BagofBonds</span></code></td>
<td>Compute a Bag of Bonds vector, as first described by Hansen et al. (2015). <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.structure.BagofBonds">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">StructuralHeterogeneity</span></code></td>
<td>Variance in the bond lengths and atomic volumes in a structure <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.structure.StructuralHeterogeneity">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">MaximumPackingEfficiency</span></code></td>
<td>Maximum possible packing efficiency of this structure <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.structure.MaximumPackingEfficiency">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">ChemicalOrdering</span></code></td>
<td>How much the ordering of species in the structure differs from random <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.structure.ChemicalOrdering">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">StructureComposition</span></code></td>
<td>Features related to the composition of a structure <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.structure.StructureComposition">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">XRDPowderPattern</span></code></td>
<td>1D array representing powder diffraction of a structure as calculated by <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.structure.XRDPowderPattern">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">CGCNNFeaturizer</span></code></td>
<td>Features generated by training a Crystal Graph Convolutional Neural Network <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.structure.CGCNNFeaturizer">[more]</a></td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">JarvisCFID</span></code></td>
<td>Classical Force-Field Inspired Descriptors (CFID) from Jarvis-ML. <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.structure.JarvisCFID">[more]</a></td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">SOAP</span></code></td>
<td>Smooth overlap of atomic positions (interface via dscribe). <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.structure.SOAP">[more]</a></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="index.html">Table of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Table of Featurizers</a><ul>
<li><a class="reference internal" href="#bandstructure">bandstructure</a><ul>
<li><a class="reference internal" href="#features-derived-from-a-material-s-electronic-bandstructure">Features derived from a material’s electronic bandstructure.</a></li>
</ul>
</li>
<li><a class="reference internal" href="#base">base</a><ul>
<li><a class="reference internal" href="#parent-classes-and-meta-featurizers">Parent classes and meta-featurizers.</a></li>
</ul>
</li>
<li><a class="reference internal" href="#composition">composition</a><ul>
<li><a class="reference internal" href="#features-based-on-a-material-s-composition">Features based on a material’s composition.</a></li>
</ul>
</li>
<li><a class="reference internal" href="#conversions">conversions</a><ul>
<li><a class="reference internal" href="#conversion-utilities">Conversion utilities.</a></li>
</ul>
</li>
<li><a class="reference internal" href="#dos">dos</a><ul>
<li><a class="reference internal" href="#features-based-on-a-material-s-electronic-density-of-states">Features based on a material’s electronic density of states.</a></li>
</ul>
</li>
<li><a class="reference internal" href="#function">function</a><ul>
<li><a class="reference internal" href="#classes-for-expanding-sets-of-features-calculated-with-other-featurizers">Classes for expanding sets of features calculated with other featurizers.</a></li>
</ul>
</li>
<li><a class="reference internal" href="#site">site</a><ul>
<li><a class="reference internal" href="#features-from-individual-sites-in-a-material-s-crystal-structure">Features from individual sites in a material’s crystal structure.</a></li>
</ul>
</li>
<li><a class="reference internal" href="#structure">structure</a><ul>
<li><a class="reference internal" href="#generating-features-based-on-a-material-s-crystal-structure">Generating features based on a material’s crystal structure.</a></li>
</ul>
</li>
</ul>
</li>
</ul>

  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/featurizer_summary.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    </div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">matminer 0.5.4 documentation</a> &#187;</li> 
      </ul>
    </div>

    <div class="footer" role="contentinfo">
        &#169; Copyright 2015, Anubhav Jain.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.2.
    </div>

  </body>
</html>